home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1999 February / Macworld (1999-02).dmg / Serious Demos / XTension demo / XTension manual 2.0 / XTension manual 2.0.rsrc / TEXT_155.txt < prev    next >
Text File  |  1998-07-18  |  2KB  |  51 lines

  1. Scheduled Event Verbs :  
  2.  
  3.  
  4. remove event: Remove a specific scheduled event
  5.  remove event  string  -- Event name
  6.     example :  remove event "Morning Coffee"
  7.     [for unit  string]  -- removes next event for this  unit
  8.  
  9. This verb will remove the next scheduled event for either the named event or for the named unit.
  10.  
  11. remove unit events:  Removes all scheduled events for a unit 
  12. remove unit events  string  -- unit name
  13.         example :  remove unit events "Coffee Pot"
  14.  
  15. This verb will remove all scheduled events for the device or group.
  16.  
  17. create event: Create a scheduled event
  18.     create event  string
  19.         that  turnson/turnsoff/toggles/executes/dims
  20.         unit  string
  21.         [to level  small integer]
  22.         [in  integer]  (seconds)
  23.         [starts at  date]  (AppleScript type date)
  24.         [repeats every  integer]  (seconds, Applescript: * Minutes,Hours,Days)
  25.         [randomize by  small integer]  (seconds only)
  26.         [with no script]  (just don't execute any attendant scripts)
  27.   [weekdays  string]  -- Use a 7-character string of this form: ‚Äú-M-W-F-‚Äù Use dashes for days not to execute.
  28.  
  29.     example :  create event  "Morning Coffee" that turnson unit "Coffee Pot" starts at 
  30.       (date)    repeats every 1 * days  weekdays "-MTWTF-"
  31.  
  32. This verb will create a new scheduled event with explicit start time and repeat period.  You can turn on/off, dim or toggle a unit, or execute a script.
  33. You can even randomize the event, and choose the weekdays.
  34.  
  35. suspend event: Suspend a scheduled event
  36.     suspend event  string  -- Event name in quotes
  37.         [for  integer]  -- seconds until 'next event time'
  38.         [until  date]  -- date and time for next event time
  39.  
  40.  
  41. unsuspend event: unSuspend a scheduled event
  42.     unsuspend event  string  -- Event name in quotes
  43.  
  44. These two verbs allow you to temporarily suspend a scheduled event.
  45. The event remains in the event list, but it just does not execute at its
  46. scheduled time if it is suspended.  
  47.  
  48. Of course, you need to know the Event Name to do so.
  49. Thus, for such events, you must assign Names to them if you expect
  50. to be able to suspend/unsuspend them.
  51.